← Tilbage til Hovedside

Overblik

Dette afsnit beskriver de tilgængelige REST-endpoints til søgning og opslag af andelsboliger.

Søgninger returnerer en liste af resultater i JSON-format, som indeholder en unik uuid for hver andelsbolig.

Dette uuid kan efterfølgende benyttes til at hente de fulde summariske oplysninger for andelsboligen i XML-format.

Endpoints

SoegningAdresse

Endpoint URL: andelsbolig/postnummervej

Method

GET

Beskrivelse

Søgning efter andelsboliger ved hjælp af adresseoplysninger (postnummer og vejnavn). Der kan søges med eller uden etage og side/dør.

Input

Query parametre:

  • postnummer

  • vejnavn

  • husnummer (valgfri)

  • etage (valgfri)

  • sidedoer (valgfri)

Output

JSON-svar indeholdende en liste af matchende andelsboliger (inkl. uuid).

Fejlhåndtering

Returnerer standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /andelsbolig/postnummervej?postnummer=4000&vejnavn=Bj%C3%B8rneklovej&husnummer=2 HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

SoegningNavnFoedselsdato

Endpoint URL: andelsbolig/personnavn

Method

GET

Beskrivelse

Søgning efter andelsboliger ved hjælp af debitors navn og fødselsdato.

Input

Query parametre:

  • navn

  • fdato

Output

JSON-svar indeholdende en liste af matchende andelsboliger (inkl. uuid).

Fejlhåndtering

Returnerer standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /andelsbolig/personnavn?navn=John%20Doe&fdato=01.01.1970 HTTP/1.1

SoegningKommunevej

Endpoint URL: andelsbolig/kommunevej

Method

GET

Beskrivelse

Søgning efter andelsboliger ved hjælp af kommunekode og vejkode. Der kan søges med eller uden etage og side/dør.

Input

Query parametre:

  • kommunekode

  • vejkode

  • husnummer (valgfri)

  • etage (valgfri)

  • sidedoer (valgfri)

Output

JSON-svar indeholdende en liste af matchende andelsboliger (inkl. uuid).

Fejlhåndtering

Returnerer standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /andelsbolig/kommunevej?kommunekode=265&vejkode=480&husnummer=2&etage=&sidedoer= HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

SoegningCvr

Endpoint URL: andelsbolig/virksomhed/{cvr}

Method

GET

Beskrivelse

Søgning efter andelsboliger ved hjælp af CVR-nummer.

Input

Path parameter:

  • cvr

Output

JSON-svar indeholdende en liste af matchende andelsboliger (inkl. uuid).

Fejlhåndtering

Returnerer standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /andelsbolig/virksomhed/15231599 HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

OpslagUUID

Endpoint URL: andelsbolig/andelsbolig/{uuid}

Method

GET

Beskrivelse

Med et uuid fra et tidligere søgesvar kan man lave et opslag for at hente de fulde summariske oplysninger for andelsboligen. Svarformatet kan styres via valgfrie query parametre.

Input

Path parameter:

  • uuid

Valgfrie query parametre:

  • xhtml=true - returnerer svaret som XHTML

  • tmvXhtml=true - returnerer svaret som TMV XHTML

  • Hvis ingen angives, returneres svaret som OIO XML (standard)

Output

XML dokument af typen AndelSummariskHentResultat (OIO XML, XHTML eller TMV XHTML afhængigt af parametre).

Formateringen af XHTML- og TMV XHTML-svar er ikke dokumenteret i detaljer og kan ændres uden varsel.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /andelsbolig/andelsbolig/76668740-6d7b-11df-be2b-0800200c9a67?xhtml=false&tmvxhtml=false HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*